FrameLib  2.0
DSP processing with frames of arbitrary timing and length
FrameLib_Block Class Reference

an abstract class that represents either a single FrameLib_DSP object, or a group of connected FrameLib_DSP objects. More...

#include <FrameLib_Object.h>

Inheritance diagram for FrameLib_Block:
FrameLib_Object< FrameLib_Block > FrameLib_Queueable< FrameLib_Block > FrameLib_DSP FrameLib_AudioInput FrameLib_AudioOutput FrameLib_Processor FrameLib_Scheduler

Public Member Functions

 FrameLib_Block (ObjectType type, FrameLib_Context context, FrameLib_Proxy *proxy)
 
virtual ~FrameLib_Block ()
 
virtual void setStream (void *streamOwner, unsigned long stream)
 
- Public Member Functions inherited from FrameLib_Object< FrameLib_Block >
 FrameLib_Object (ObjectType type, FrameLib_Context context, FrameLib_Proxy *proxy)
 
virtual ~FrameLib_Object ()
 
ObjectType getType () const
 
FrameLib_Context getContext () const
 
FrameLib_ProxygetProxy () const
 
unsigned long getNumIns () const
 
unsigned long getNumOuts () const
 
unsigned long getNumAudioIns () const
 
unsigned long getNumAudioOuts () const
 
unsigned long getNumAudioChans () const
 
virtual void setFixedInput (unsigned long idx, double *input, unsigned long size)=0
 
virtual const double * getFixedInput (unsigned long idx, unsigned long *size)=0
 
virtual void blockUpdate (const double *const *ins, double **outs, unsigned long blockSize)=0
 
virtual void reset (double samplingRate, unsigned long maxBlockSize)=0
 
virtual std::string objectInfo (bool verbose=false)
 
virtual std::string inputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string outputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string audioInfo (unsigned long idx, bool verbose=false)
 
virtual FrameType inputType (unsigned long idx) const=0
 
virtual FrameType outputType (unsigned long idx) const=0
 
virtual const FrameLib_ParametersgetParameters () const
 
ConnectionResult addConnection (Connection connection, unsigned long inIdx)
 
void deleteConnection (unsigned long inIdx)
 
ConnectionResult addOrderingConnection (Connection connection)
 
void deleteOrderingConnection (Connection connection)
 
void clearOrderingConnections ()
 
void clearConnections ()
 
ConnectionResult setInputAlias (Connection alias, unsigned long inIdx)
 
ConnectionResult setOrderingAlias (FrameLib_Block *alias)
 
ConnectionResult setOutputAlias (Connection alias, unsigned long outIdx)
 
bool isConnected (unsigned long inIdx) const
 
Connection getConnection (unsigned long inIdx) const
 
bool supportsOrderingConnections () const
 
unsigned long getNumOrderingConnections () const
 
Connection getOrderingConnection (unsigned long idx) const
 
virtual void autoOrderingConnections ()=0
 
virtual void clearAutoOrderingConnections ()=0
 
void callConnectionUpdate ()
 
void addOutputDependencies (std::vector< U * > &dependencies)
 
void addOutputDependencies (std::vector< U * > &dependencies, unsigned long outIdx)
 
- Public Member Functions inherited from FrameLib_Queueable< FrameLib_Block >
 FrameLib_Queueable ()
 

Additional Inherited Members

- Public Types inherited from FrameLib_Object< FrameLib_Block >
using Queue = typename FrameLib_Queueable< FrameLib_Block >::Queue
 
- Static Public Member Functions inherited from FrameLib_Object< FrameLib_Block >
static bool handlesAudio ()
 
- Protected Member Functions inherited from FrameLib_Object< FrameLib_Block >
void addOutputDependencies (Queue *queue)
 
void addOutputDependencies (Queue *queue, unsigned long outIdx)
 
Connection getConnectionInternal (unsigned long inIdx) const
 
Connection getOrderingConnectionInternal (unsigned long idx) const
 
void setIO (unsigned long nIns, unsigned long nOuts, unsigned long nAudioChans=0)
 
void enableOrderingConnections ()
 
U * alloc (unsigned long N)
 
void dealloc (U *&ptr)
 
void clearAllocator ()
 
FrameLib_LocalAllocator::StorageregisterStorage (const char *name)
 
void releaseStorage (FrameLib_LocalAllocator::Storage *&storage)
 
const double * getEmptyFixedInput (unsigned long idx, unsigned long *size)
 
- Static Protected Member Functions inherited from FrameLib_Object< FrameLib_Block >
static const char * formatInfo (const char *verboseStr, const char *briefStr, bool verbose)
 
static std::string formatInfo (const char *str, unsigned long idx)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, unsigned long idx, bool verbose)
 
static std::string formatInfo (const char *str, const char *replaceStr)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, const char *replaceStr, bool verbose)
 
static std::string parameterInputInfo (bool verbose)
 
static std::string numberedString (const char *str, unsigned long idx)
 
static bool addUniqueItem (std::vector< U > &list, U item)
 
static bool deleteUniqueItem (std::vector< U > &list, U item)
 

Detailed Description

an abstract class that represents either a single FrameLib_DSP object, or a group of connected FrameLib_DSP objects.

This abstract class provides a connectivity interface to FrameLib_DSP objects or blocks (groups of FrameLib_DSP objects). Most objects inherit this in the FrameLib_DSP class. Objects that have asynchronous outputs can use this class to host multiple FrameLib_DSP objects and alias the connections correctly.

Constructor & Destructor Documentation

◆ FrameLib_Block()

FrameLib_Block::FrameLib_Block ( ObjectType  type,
FrameLib_Context  context,
FrameLib_Proxy proxy 
)
inline

◆ ~FrameLib_Block()

virtual FrameLib_Block::~FrameLib_Block ( )
inlinevirtual

Member Function Documentation

◆ setStream()

virtual void FrameLib_Block::setStream ( void *  streamOwner,
unsigned long  stream 
)
inlinevirtual

The documentation for this class was generated from the following file: